/*
 * Copyright (C) 2012 SeekDeepWithin.com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package com.seekdeepwithin.Data;

import javafx.beans.property.*;
import javafx.scene.control.Tooltip;

/**
 * User: Jonathan Montiverdi
 * Date: Oct 3, 2012
 *
 * Interface for all the tabs in the application.
 */
public interface ITab
{
    /**
     * Gets the title of the tab.
     * @return The title of the tab.
     */
    String getTabTitle ();

    /**
     * Gets the title of the tab property.
     * @return Tab title property.
     */
    StringProperty tabTitleProperty ();

    /**
     * Gets the tool tip of the tab.
     * @return The tool tip of the tab.
     */
    Tooltip getTabToolTip ();

    /**
     * Gets the tool tip of the tab property.
     * @return Tab tool tip property.
     */
    ObjectProperty<Tooltip> tabToolTipProperty ();

    /**
     * Occurs when the tab is closing.
     */
    void closing ();
}
